Server Automation Guide - ScxV6Area.ID Method

Returns the unique numeric identifier of the Area of Interest.

Remarks

Both copying and moving an area of interest into a new parent require the ID of the target Area of Interest.

Example:

The following example written in Visual Basic moves one group into another.

Dim Svr As ScxV6DbClient.ScxV6Server

Dim Areas As ScxV6DbClient.ScxV6Areas

' Connect to the server

Svr = New ScxV6DbClient.ScxV6Server()

Svr.Connect("MAIN", "", "")

' Find the area of interest we want to move

Areas = Svr.RootArea.List

Dim AreaToMove As ScxV6DbClient.ScxV6Area

AreaToMove = Nothing

Dim TargetAreaId As Integer

For Each Area As ScxV6DbClient.ScxV6Area In Areas

If Area.Name = "Target" Then

TargetAreaId = Area.ID

ElseIf Area.Name = "Area 2" Then

AreaToMove = Area

End If

If (Not AreaToMove Is Nothing) Then

AreaToMove.Move(TargetAreaId)

End If

' Disconnect

Svr.Disconnect()